GetContentStorageUnit

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODLinkSource

GetContentStorageUnit
The GetContentStorageUnit method returns a reference to the content storage unit for this link-source object.
ODStorageUnit GetContentStorageUnit (in ODLinkKey key);
key
A valid link key obtained by a prior call to the Lock method.
return value
A reference to this link-source object's content storage unit.

DISCUSSION
The key parameter ensures thread safety. Before calling this method, you must call the Lock method to obtain this key.
The returned storage unit remains valid until the key is relinquished by the Unlock method. The link-source object handles the creation and destruction of its content storage unit, so you must neither dispose of nor release the returned storage unit.
You must not cache the returned storage unit; instead you must call this method whenever you need to access the content storage unit.

EXCEPTIONS

kODErrInvalidLinkKey
The key parameter is not a valid key for this link-source object.

SEE ALSO
The ODLinkKey type (page 924).
The ODLinkSource::Lock method (page 382).
The ODLinkSource::Unlock method (page 388).
The ODStorageUnit class (page 664).
"Data Configuration" on page 315 in OpenDoc Programmer's Guide.